﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;

#region "Custom namespace declarations"
using Comkarl.Architecture.Patterns.MVC.Entities;
#endregion

namespace Comkarl
{
    /// <summary>
    /// This exception is thrown when an error related to identifiers is found.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the identifier's name.
    /// </typeparam>
    public class IdentifierException<TIdentifierName> : ExceptionBase where TIdentifierName : IEquatable<TIdentifierName>
    {
        #region "Fields"
        /// <summary>
        /// Retrieves the identifier on which the exception has been thrown.
        /// </summary>
        private readonly Identifier<TIdentifierName> currentIdentifier;
        #endregion

        #region "Constructors"
        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="message">
        /// A custom message to show when this is thrown.
        /// </param>
        /// <param name="currentIdentifier">
        /// The identifier of the identified-entity on which the error has been found.
        /// </param>
        /// <param name="innerException">
        /// An optional exception which can be set if some underlying exception has been thrown.
        /// </param>
        public IdentifierException(string message, Identifier<TIdentifierName> currentIdentifier, Exception innerException)
            : base(message, innerException)
        {
            this.currentIdentifier = currentIdentifier;
        }
        #endregion

        #region "Properties"
        /// <summary>
        /// Gets the identifier of the identified-entity on which the error has been found.
        /// </summary>
        public Identifier<TIdentifierName> CurrentIdentifier
        {
            get
            {
                return currentIdentifier;
            }
        }
        #endregion
    }
}
